e-digital-web-api
Order Management
Order Retrieval
At Knauf we structure our order portfolio in order hierarchies.
In our API we only expose the order hierarchy. That can be requested with these endpoints:
| Endpoint | Description |
|---|---|
| /sales-orders | Get the a list of cached orders based on pagination and date inputs (with a limit of 100 records), with information around each order and its products. |
The different ID fields
In the response from /sales-order the following identifiers will be available:
- order.number: Unique identifier of the orders within the total number .
- customerId: ID of the customer associated with a given order
Using the order.number or customerId parameters its possible to get information for a single order using the endpoints described in the Order Details section in accordance with the object's type.
Output
In the output for the sales-order endpoint, the number of records provided will depend on the specified parameters, which can be based on date (to and from) or pagination (continuationToken and limit). A parameter in the output response will indicate whether there are more records than the obtained, with the boolean hasMoreRecords.
Pagination can be leveraged by using the next link provided in the response from the initial request, by making use of it in the exposed header parameter continuationToken in subsequent requests.
Order details by id
The following endpoint provides a resource to retrieve order information based on a given id passed as URI parameter.
| Endpoint | Description |
|---|---|
| /sales-orders/{id} | Get information about order with specified id |
Deliveries retrieval
In our API we only expose the deliveries hierarchy. That can be requested with these endpoints:
| Endpoint | Description |
|---|---|
| /deliveries | Get the a list of cached orders deliveries based on pagination and sales order number inputs, with information around each order delivery. |
Shipments retrieval
In our API we only expose the shipments hierarchy. That can be requested with these endpoints:
| Endpoint | Description |
|---|---|
| /shipments | Get the a list of cached orders shipments based on pagination and sales order number inputs, with information around each order shipment. |